<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2rhino.doc.block</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2rhino-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2rhino</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2rhino-module.html">Package&nbsp;py2rhino</a> ::
        <a href="py2rhino.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;block
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2rhino.doc.block-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module block</h1><p class="nomargin-top"><span class="codelink"><a href="py2rhino.doc.block-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#container_count" class="summary-sig-name">container_count</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Returns the number of block definitions that contain a specified 
      block definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#container_count">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#containers" class="summary-sig-name">containers</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Returns the names of the block definitions that contain a specified 
      block definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#containers">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#count" class="summary-sig-name">count</a>()</span><br />
      Returns the number of block definitions in the document.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#count">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#description" class="summary-sig-name">description</a>(<span class="summary-sig-arg">block_name</span>,
        <span class="summary-sig-arg">text</span>=<span class="summary-sig-default">pythoncom.Empty</span>)</span><br />
      Returns or sets the description of a block definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#description">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#instance_count" class="summary-sig-name">instance_count</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Counts the number of instances of the block in the document.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_count">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#instance_insert_point" class="summary-sig-name">instance_insert_point</a>(<span class="summary-sig-arg">block_id</span>)</span><br />
      Returns the insertion point of a block instance.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_insert_point">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#instance_name" class="summary-sig-name">instance_name</a>(<span class="summary-sig-arg">block_id</span>)</span><br />
      Returns the block name of a block instance.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#instance_xform" class="summary-sig-name">instance_xform</a>(<span class="summary-sig-arg">block_id</span>)</span><br />
      Returns the location of a block instance relative to the world 
      coordinate system origin (0,0,0).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_xform">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#instances" class="summary-sig-name">instances</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Returns the identifiers of the inserted instances of a block.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instances">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#names" class="summary-sig-name">names</a>(<span class="summary-sig-arg">sort</span>=<span class="summary-sig-default">pythoncom.Empty</span>)</span><br />
      Returns the names of all block definitions in the document.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#names">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#object_count" class="summary-sig-name">object_count</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Returns the number of objects that make up a block definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#object_count">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#objects" class="summary-sig-name">objects</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Returns the identifiers of the objects that make up a block 
      definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#objects">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#path" class="summary-sig-name">path</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Returns the path to the source of a linked or embedded block 
      definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#path">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#url" class="summary-sig-name">url</a>(<span class="summary-sig-arg">block_name</span>,
        <span class="summary-sig-arg">url</span>=<span class="summary-sig-default">pythoncom.Empty</span>)</span><br />
      Returns or sets the URL of a block definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#url">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#url_tag" class="summary-sig-name">url_tag</a>(<span class="summary-sig-arg">block_name</span>,
        <span class="summary-sig-arg">url</span>=<span class="summary-sig-default">pythoncom.Empty</span>)</span><br />
      Returns or sets the URL tag, or description, of a block definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#url_tag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Deletes a block definition and all of it's inserted instances.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#delete">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#explode_instance" class="summary-sig-name">explode_instance</a>(<span class="summary-sig-arg">block_id</span>)</span><br />
      Explodes a block instance into it's geometric components.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#explode_instance">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#insert" class="summary-sig-name">insert</a>(<span class="summary-sig-arg">block_name</span>,
        <span class="summary-sig-arg">insertion_point</span>,
        <span class="summary-sig-arg">scale</span>=<span class="summary-sig-default">pythoncom.Empty</span>,
        <span class="summary-sig-arg">angle</span>=<span class="summary-sig-default">pythoncom.Empty</span>,
        <span class="summary-sig-arg">normal</span>=<span class="summary-sig-default">pythoncom.Empty</span>)</span><br />
      Inserts a block whose definition already exists in the document.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#insert">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#insert_by_xform" class="summary-sig-name">insert_by_xform</a>(<span class="summary-sig-arg">block_name</span>,
        <span class="summary-sig-arg">xform</span>)</span><br />
      Inserts a block whose definition already exists in the document.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#insert_by_xform">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#is_block" class="summary-sig-name">is_block</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Verifies the existence of a block definition in the document.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_block">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#is_embedded" class="summary-sig-name">is_embedded</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Verifies that a block definition is embedded, or linked, from an 
      external file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_embedded">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#is_in_use" class="summary-sig-name">is_in_use</a>(<span class="summary-sig-arg">block_name</span>,
        <span class="summary-sig-arg">where</span>=<span class="summary-sig-default">pythoncom.Empty</span>)</span><br />
      Verifies that a block definition is being used by an inserted instance.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_in_use">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#is_instance" class="summary-sig-name">is_instance</a>(<span class="summary-sig-arg">block_id</span>)</span><br />
      Verifies an object is a block instance.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_instance">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#is_reference" class="summary-sig-name">is_reference</a>(<span class="summary-sig-arg">block_name</span>)</span><br />
      Verifies that a block definition is from a reference file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_reference">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.doc.block-module.html#rename" class="summary-sig-name">rename</a>(<span class="summary-sig-arg">old_block_name</span>,
        <span class="summary-sig-arg">new_block_name</span>)</span><br />
      Renames an existing block definition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.doc.block-pysrc.html#rename">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="container_count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">container_count</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#container_count">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of block definitions that contain a specified block
  definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>number - The number of block definitions that contain the specified 
    block definition if successful. None - If not successful, or on 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: 
    BlockContainerCount</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="containers"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">containers</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#containers">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the names of the block definitions that contain a specified 
  block definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>list - A list of block definition names if successful. None - If not
    successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockContainers</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">count</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#count">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of block definitions in the document.</p>
  <h1 class="heading">Parameters</h1>
    <p>No parameters</p>
  <h1 class="heading">Returns</h1>
    <p>number - The number of block definitions in the document. None - On 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockCount</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="description"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">description</span>(<span class="sig-arg">block_name</span>,
        <span class="sig-arg">text</span>=<span class="sig-default">pythoncom.Empty</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#description">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns or sets the description of a block definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition. text  (string, Optional) - The new description.  If 
    omitted, the current description is returned.</p>
  <h1 class="heading">Returns</h1>
    <p>string - If a description is not specified,  the current description
    if successful. string - If a description is specified, the previous 
    description if successful. None - If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockDescription</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="instance_count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">instance_count</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_count">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Counts the number of instances of the block in the document.  Nested 
  instances are not included in the count.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>number - The number of instances of the block in the document if 
    successful. None - If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockInstanceCount</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="instance_insert_point"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">instance_insert_point</span>(<span class="sig-arg">block_id</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_insert_point">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the insertion point of a block instance.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_id  (string, Required) - The identifier of an existing block 
    insertion object.</p>
  <h1 class="heading">Returns</h1>
    <p>list - A 3-D point if successful. None - If not successful, or on 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: 
    BlockInstanceInsertPoint</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="instance_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">instance_name</span>(<span class="sig-arg">block_id</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the block name of a block instance.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_id  (string, Required) - The identifier of an existing block 
    insertion object.</p>
  <h1 class="heading">Returns</h1>
    <p>string - The block name if successful. None - If not successful, or 
    on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockInstanceName</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="instance_xform"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">instance_xform</span>(<span class="sig-arg">block_id</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instance_xform">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the location of a block instance relative to the world 
  coordinate system origin (0,0,0).  The position is returned as a 4x4 
  transformation matrix</p>
  <h1 class="heading">Parameters</h1>
    <p>block_id  (string, Required) - The identifier of an existing block 
    insertion object.</p>
  <h1 class="heading">Returns</h1>
    <p>list - A transformation matrix (4x4 list of numbers) if successful. 
    None - If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockInstanceXform</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="instances"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">instances</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#instances">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the identifiers of the inserted instances of a block.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>list - A list of strings identifying the instances of a block if 
    successful. None - If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockInstances</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="names"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">names</span>(<span class="sig-arg">sort</span>=<span class="sig-default">pythoncom.Empty</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#names">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the names of all block definitions in the document.</p>
  <h1 class="heading">Parameters</h1>
    <p>sort  (boolean, Optional) - Return a sorted list of block definition
    names.</p>
  <h1 class="heading">Returns</h1>
    <p>list - A list of block definition names if successful. None - If not
    successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockNames</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="object_count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">object_count</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#object_count">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of objects that make up a block definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>number - The number of objects that make up the block definition if 
    successful. None - If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockObjectCount</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="objects"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">objects</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#objects">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the identifiers of the objects that make up a block 
  definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>list - A list of strings identifying the objects that make up a 
    block definition if successful. None - If not successful, or on 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockObjects</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="path"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">path</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#path">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the path to the source of a linked or embedded block 
  definition.  A linked or embedded block definition is a block definition 
  that was inserted from an external file.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>string - The path to the linked block file is successful. None - If 
    not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockPath</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="url"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">url</span>(<span class="sig-arg">block_name</span>,
        <span class="sig-arg">url</span>=<span class="sig-default">pythoncom.Empty</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#url">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns or sets the URL of a block definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition. url  (string, Optional) - The new URL.  If omitted, the 
    current URL is returned.</p>
  <h1 class="heading">Returns</h1>
    <p>string - If a URL is not specified,  the current URL if successful. 
    string - If a URL is specified, the previous URL if successful. None - 
    If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockURL</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="url_tag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">url_tag</span>(<span class="sig-arg">block_name</span>,
        <span class="sig-arg">url</span>=<span class="sig-default">pythoncom.Empty</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#url_tag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns or sets the URL tag, or description, of a block 
  definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition. url  (string, Optional) - The new URL tag.  If omitted, the
    current URL tag is returned.</p>
  <h1 class="heading">Returns</h1>
    <p>string - If a URL tag is not specified,  the current URL tag if 
    successful. string - If a URL tag is specified, the previous URL tag if
    successful. None - If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: BlockURLTag</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Deletes a block definition and all of it's inserted instances.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True or false indicating success or failure. None - On 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: DeleteBlock</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="explode_instance"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">explode_instance</span>(<span class="sig-arg">block_id</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#explode_instance">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Explodes a block instance into it's geometric components.  The 
  exploded objects are added to the document.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_id  (string, Required) - The identifier of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>list - A list of strings identifying the newly exploded objects if 
    successful. None - If not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: 
    ExplodeBlockInstance</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="insert"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">insert</span>(<span class="sig-arg">block_name</span>,
        <span class="sig-arg">insertion_point</span>,
        <span class="sig-arg">scale</span>=<span class="sig-default">pythoncom.Empty</span>,
        <span class="sig-arg">angle</span>=<span class="sig-default">pythoncom.Empty</span>,
        <span class="sig-arg">normal</span>=<span class="sig-default">pythoncom.Empty</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#insert">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Inserts a block whose definition already exists in the document.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of the block definition to
    insert. insertion_point  (List of float, Required) - The 3-D insertion 
    point of the block. scale  (List of float, Optional) - An list of three
    numbers that identify the x,y,z scale factors. If omitted, the block is
    not scaled. angle  (float, Optional) - The rotation angle in degrees. 
    If omitted, the block is not rotated. normal  (List of float, Optional)
    - A 3-D vector identifying the axis of rotation. If omitted and 
    dblAngle is specified, the world Z axis is used.</p>
  <h1 class="heading">Returns</h1>
    <p>string - The newly inserted block instance, if successful. None - If
    not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: InsertBlock</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="insert_by_xform"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">insert_by_xform</span>(<span class="sig-arg">block_name</span>,
        <span class="sig-arg">xform</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#insert_by_xform">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Inserts a block whose definition already exists in the document.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of the block definition to
    insert. xform  (List of float, Required) - 4x4 transformation matrix to
    apply.</p>
  <h1 class="heading">Returns</h1>
    <p>string - The newly inserted block instance, if successful. None - If
    not successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: InsertBlock</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_block"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_block</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_block">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Verifies the existence of a block definition in the document.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True or false indicating success or failure. None - On 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: IsBlock</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_embedded"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_embedded</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_embedded">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Verifies that a block definition is embedded, or linked, from an 
  external file.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True or false indicating success or failure. None - On 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: IsBlockEmbedded</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_in_use"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_in_use</span>(<span class="sig-arg">block_name</span>,
        <span class="sig-arg">where</span>=<span class="sig-default">pythoncom.Empty</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_in_use">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">


Verifies that a block definition is being used by an inserted instance.

Parameters
==========
block_name  (string, Required) - The name of an existing block definition.
where  (integer, Optional) - Where to look, where:
        0 (Default)
        Check for top level references in active document
        1
        Check for top level and nested references in active document
        2

Returns
=======
boolean - True or false indicating success or failure.
None - On error.

Rhinoscript
===========
This function calls the Rhinoscript function: IsBlockInUse

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_instance"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_instance</span>(<span class="sig-arg">block_id</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_instance">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Verifies an object is a block instance.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_id  (string, Required) - The identifier of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True or false indicating success or failure. None - On 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: IsBlockInstance</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_reference"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_reference</span>(<span class="sig-arg">block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#is_reference">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Verifies that a block definition is from a reference file.</p>
  <h1 class="heading">Parameters</h1>
    <p>block_name  (string, Required) - The name of an existing block 
    definition.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True or false indicating success or failure. None - On 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: IsBlockReference</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rename"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rename</span>(<span class="sig-arg">old_block_name</span>,
        <span class="sig-arg">new_block_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.doc.block-pysrc.html#rename">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Renames an existing block definition.</p>
  <h1 class="heading">Parameters</h1>
    <p>old_block_name  (string, Required) - The name of an existing block 
    definition. new_block_name  (string, Required) - The new block 
    definition name.</p>
  <h1 class="heading">Returns</h1>
    <p>string - The new block definition name if successful. None - If not 
    successful, or on error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: RenameBlock</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2rhino-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2rhino</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Sep 02 08:00:03 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
